<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mbox: xmbox.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">mbox
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xmbox_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xmbox.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga34fbeaf8de9092cb4d5b00dfbf054426"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#ga34fbeaf8de9092cb4d5b00dfbf054426">XMbox_CfgInitialize</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, <a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> *ConfigPtr, UINTPTR EffectiveAddress)</td></tr>
<tr class="memdesc:ga34fbeaf8de9092cb4d5b00dfbf054426"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a specific mailbox.  <a href="group__mbox__v4__0.html#ga34fbeaf8de9092cb4d5b00dfbf054426">More...</a><br /></td></tr>
<tr class="separator:ga34fbeaf8de9092cb4d5b00dfbf054426"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa1f68405027d147c68aa53bcb49fbd5a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#gaa1f68405027d147c68aa53bcb49fbd5a">XMbox_Read</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 *BufferPtr, u32 RequestedBytes, u32 *BytesRecvdPtr)</td></tr>
<tr class="memdesc:gaa1f68405027d147c68aa53bcb49fbd5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads requested bytes from the mailbox referenced by InstancePtr,into the buffer pointed to by the provided pointer.  <a href="group__mbox__v4__0.html#gaa1f68405027d147c68aa53bcb49fbd5a">More...</a><br /></td></tr>
<tr class="separator:gaa1f68405027d147c68aa53bcb49fbd5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab14511b623c1d3c191cdc441b8909006"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#gab14511b623c1d3c191cdc441b8909006">XMbox_ReadBlocking</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 *BufferPtr, u32 RequestedBytes)</td></tr>
<tr class="memdesc:gab14511b623c1d3c191cdc441b8909006"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads requested bytes from the mailbox referenced by InstancePtr,into the buffer pointed to by the provided pointer.  <a href="group__mbox__v4__0.html#gab14511b623c1d3c191cdc441b8909006">More...</a><br /></td></tr>
<tr class="separator:gab14511b623c1d3c191cdc441b8909006"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga254c4e5a042e34520c3669fbf9651bc2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#ga254c4e5a042e34520c3669fbf9651bc2">XMbox_Write</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 *BufferPtr, u32 RequestedBytes, u32 *BytesSentPtr)</td></tr>
<tr class="memdesc:ga254c4e5a042e34520c3669fbf9651bc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the requested bytes from the buffer pointed to by the provided pointer into the mailbox referenced by InstancePtr.The number of bytes must be a multiple of 4 (bytes).  <a href="group__mbox__v4__0.html#ga254c4e5a042e34520c3669fbf9651bc2">More...</a><br /></td></tr>
<tr class="separator:ga254c4e5a042e34520c3669fbf9651bc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga23ee00f97807790770f2dab9b2ea3b0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#ga23ee00f97807790770f2dab9b2ea3b0e">XMbox_WriteBlocking</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 *BufferPtr, u32 RequestedBytes)</td></tr>
<tr class="memdesc:ga23ee00f97807790770f2dab9b2ea3b0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the requested bytes from the buffer pointed to by the provided pointer into the mailbox referenced by InstancePtr.  <a href="group__mbox__v4__0.html#ga23ee00f97807790770f2dab9b2ea3b0e">More...</a><br /></td></tr>
<tr class="separator:ga23ee00f97807790770f2dab9b2ea3b0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabb01fe466ffcd0da315ffee115f4cd60"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#gabb01fe466ffcd0da315ffee115f4cd60">XMbox_IsEmpty</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr class="memdesc:gabb01fe466ffcd0da315ffee115f4cd60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks to see if there is data available to be read.  <a href="group__mbox__v4__0.html#gabb01fe466ffcd0da315ffee115f4cd60">More...</a><br /></td></tr>
<tr class="separator:gabb01fe466ffcd0da315ffee115f4cd60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa9db05bc2935bcc2230ff023b5c9cbcc"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#gaa9db05bc2935bcc2230ff023b5c9cbcc">XMbox_IsFull</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaa9db05bc2935bcc2230ff023b5c9cbcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks to see if there is room in the write FIFO.  <a href="group__mbox__v4__0.html#gaa9db05bc2935bcc2230ff023b5c9cbcc">More...</a><br /></td></tr>
<tr class="separator:gaa9db05bc2935bcc2230ff023b5c9cbcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga10691489238a2a1b8515468b416d773e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#ga10691489238a2a1b8515468b416d773e">XMbox_Flush</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga10691489238a2a1b8515468b416d773e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the mailbox FIFOs by empting the READ FIFO and making sure the Error Status is zero.  <a href="group__mbox__v4__0.html#ga10691489238a2a1b8515468b416d773e">More...</a><br /></td></tr>
<tr class="separator:ga10691489238a2a1b8515468b416d773e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8e56860ea2cf7f4f1df0f1862d8c4c61"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#ga8e56860ea2cf7f4f1df0f1862d8c4c61">XMbox_SetInterruptEnable</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:ga8e56860ea2cf7f4f1df0f1862d8c4c61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the interrupt enable register for this mailbox.  <a href="group__mbox__v4__0.html#ga8e56860ea2cf7f4f1df0f1862d8c4c61">More...</a><br /></td></tr>
<tr class="separator:ga8e56860ea2cf7f4f1df0f1862d8c4c61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacb96b1964aa476b4d60df4fd2440022c"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#gacb96b1964aa476b4d60df4fd2440022c">XMbox_GetInterruptEnable</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr class="memdesc:gacb96b1964aa476b4d60df4fd2440022c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the interrupt enable for the mailbox.  <a href="group__mbox__v4__0.html#gacb96b1964aa476b4d60df4fd2440022c">More...</a><br /></td></tr>
<tr class="separator:gacb96b1964aa476b4d60df4fd2440022c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf73757d06d4cc60466e563ab185a6c07"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#gaf73757d06d4cc60466e563ab185a6c07">XMbox_GetInterruptStatus</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaf73757d06d4cc60466e563ab185a6c07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the interrupt status for the mailbox.  <a href="group__mbox__v4__0.html#gaf73757d06d4cc60466e563ab185a6c07">More...</a><br /></td></tr>
<tr class="separator:gaf73757d06d4cc60466e563ab185a6c07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab93a50b0032e4b6202c23c4201e0591e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#gab93a50b0032e4b6202c23c4201e0591e">XMbox_ClearInterrupt</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:gab93a50b0032e4b6202c23c4201e0591e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears pending interrupts with the provided mask.  <a href="group__mbox__v4__0.html#gab93a50b0032e4b6202c23c4201e0591e">More...</a><br /></td></tr>
<tr class="separator:gab93a50b0032e4b6202c23c4201e0591e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4fb918498d8adc676f4ea554585609d2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#ga4fb918498d8adc676f4ea554585609d2">XMbox_SetSendThreshold</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 Value)</td></tr>
<tr class="memdesc:ga4fb918498d8adc676f4ea554585609d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Send Interrupt Threshold.  <a href="group__mbox__v4__0.html#ga4fb918498d8adc676f4ea554585609d2">More...</a><br /></td></tr>
<tr class="separator:ga4fb918498d8adc676f4ea554585609d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8c05b007d0f92ca32702db58573302a9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#ga8c05b007d0f92ca32702db58573302a9">XMbox_SetReceiveThreshold</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 Value)</td></tr>
<tr class="memdesc:ga8c05b007d0f92ca32702db58573302a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the Receive Interrupt Threshold.  <a href="group__mbox__v4__0.html#ga8c05b007d0f92ca32702db58573302a9">More...</a><br /></td></tr>
<tr class="separator:ga8c05b007d0f92ca32702db58573302a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8620711a04da0032b216e3f57a80570d"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mbox__v4__0.html#ga8620711a04da0032b216e3f57a80570d">XMbox_GetStatus</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga8620711a04da0032b216e3f57a80570d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns Status register contents.  <a href="group__mbox__v4__0.html#ga8620711a04da0032b216e3f57a80570d">More...</a><br /></td></tr>
<tr class="separator:ga8620711a04da0032b216e3f57a80570d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
